Summary

Fully Qualified Name:	Laminas\Session\SaveHandler\MongoDBOptions
Extends:	AbstractOptions

Description

Methods

Name	Description	Defined By
__construct()	{@inheritdoc}	MongoDBOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Override AbstractOptions::__set	MongoDBOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getCollection()	Get collection name	MongoDBOptions
getDataField()	Get data field	MongoDBOptions
getDatabase()	Get database name	MongoDBOptions
getLifetimeField()	Get lifetime Field	MongoDBOptions
getModifiedField()	Get modified Field	MongoDBOptions
getNameField()	Get name field	MongoDBOptions
getSaveOptions()	Get save options	MongoDBOptions
setCollection()	Set collection name	MongoDBOptions
setDataField()	Set data field	MongoDBOptions
setDatabase()	Set database name	MongoDBOptions
setFromArray()	Set one or more configuration properties	AbstractOptions
setLifetimeField()	Set lifetime field	MongoDBOptions
setModifiedField()	Set Modified Field	MongoDBOptions
setNameField()	Set name field	MongoDBOptions
setSaveOptions()	Set save options	MongoDBOptions
setUseExpireAfterSecondsIndex()	Enable expireAfterSeconds index.	MongoDBOptions
toArray()	Cast to array	AbstractOptions
useExpireAfterSecondsIndex()		MongoDBOptions

Method Details

__construct()

{@inheritdoc}

Parameter Name	Type	Description
$options

Returns:

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Override AbstractOptions::__set

Validates value if save options are being set.

Parameter Name	Type	Description
$key	string
$value	mixed

Returns:

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getCollection()

Get collection name

Returns: string

getDataField()

Get data field

Returns: string

getDatabase()

Get database name

Returns: string

getLifetimeField()

Get lifetime Field

Returns: string

getModifiedField()

Get modified Field

Returns: string

getNameField()

Get name field

Returns: string

getSaveOptions()

Get save options

Returns: string

setCollection()

Set collection name

Parameter Name	Type	Description
$collection	string

Returns: \MongoDBOptions

setDataField()

Set data field

Parameter Name	Type	Description
$dataField	string

Returns: \MongoDBOptions

setDatabase()

Set database name

Parameter Name	Type	Description
$database	string

Returns: \MongoDBOptions

setFromArray()

Set one or more configuration properties

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setLifetimeField()

Set lifetime field

Parameter Name	Type	Description
$lifetimeField	string

Returns: \MongoDBOptions

setModifiedField()

Set Modified Field

Parameter Name	Type	Description
$modifiedField	string

Returns: \MongoDBOptions

setNameField()

Set name field

Parameter Name	Type	Description
$nameField	string

Returns: \MongoDBOptions

setSaveOptions()

Set save options

Parameter Name	Type	Description
$saveOptions	array

Returns: \MongoDBOptions

setUseExpireAfterSecondsIndex()

Enable expireAfterSeconds index.

Parameter Name	Type	Description
$useExpireAfterSecondsIndex	bool

Returns:

toArray()

Cast to array

Returns: array

useExpireAfterSecondsIndex()

Returns: bool